<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。JCAT 由中国团队开发维护。
//  正在使用的这个版本是：0.5.0 / SVN信息: $Id: class.JCAT_ClassPackage.php 1603 2009-03-31 15:35:42Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [下载(HTTP)] http://code.google.com/p/jcat-php/downloads/list
//    [下载(svn)] svn checkout http://jcat-php.googlecode.com/svn/branches/0.4.0/Framework/ JCAT0.4
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.com/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.com/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/
namespace JCAT ;


/**
 * 用于管理 class(interface) 的加载
 *
 * @author		alee
 * @access		public
 */
class ClassPackage
{
	/**
	 * 构造函数
	 *
	 * @access	public
	 * @return	void
	 */
	public function ClassPackage($sPath)
	{
		if( !is_dir($sPath) )
		{
			throw new Exception("the directory path invalid:{$sPath}") ;
		}
		
		$this->sPath = realpath($sPath).'/' ;
		$this->AddClassFilenameParser(array(__CLASS__,'ParseFilename'));
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$Parameter
	 * @return	void
	 */
	public function __sleep()
	{
		return array(
			ClassEx::MakePrivateNameForSerialize('arrClassesPath',__CLASS__)
		) ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$sClassname
	 * @return	string
	 */
	public function QueryClass($sClassname)
	{
		return isset($this->arrClassesPath[$sClassname])?
				$this->GetPath().$this->arrClassesPath[$sClassname]: null ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @return	void
	 */
	public function GetPath()
	{
		return $this->sPath ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$Parser		callback
	 * @return	void
	 */
	public function AddClassFilenameParser($Parser)
	{
		ASSERT::ASSERT_ISTHESE($Parser,array('callback'));
		$this->arrClassFilenameParser[] = $Parser ;
	}

	/**
	 * 注册 类-类文件
	 * 
	 * @access	public
	 * @param	$sClass				string		what's this
	 * @param	$sSubPath			string		what's this
	 * @return	void
	 */
	public function RegisterClass($sClass,$sSubPath)
	{
		if( !is_string($sClass) )
		{
			exit( Language::SentenceEx('参数 $sClass 必须是一个字符串格式的类名','JCAT',null,$sClass) ) ;
		}

		$this->arrClassesPath[$sClass] = $sSubPath ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @return	string
	 */
	public function GetClassesPathFile()
	{
		return $this->GetPath().$this->sClassesPathFilename ;
	}
	
	/**
	 * 载入类文件清单
	 * 
	 * @access	public
	 * @param 	$bForceRefreshCache=false
	 * @return	void
	 */
	public function LoadClassList($bForceRefreshCache=false)
	{
		$sClassesPathFile = $this->GetClassesPathFile() ;
		if( !$bForceRefreshCache and is_file($sClassesPathFile) )
		{
			$sCacheContent = file_get_contents($sClassesPathFile) ;
			$arrClassesFile = unserialize($sCacheContent) ;
			if( is_array($arrClassesFile) )
			{
				$this->arrClassesPath = $arrClassesFile ;
				return ;
			}
		}
		
		
			$this->_ScanClass($this->GetPath(),'') ;
			$this->SaveCache() ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @return	void
	 */
	public function SaveCache()
	{		
		file_put_contents(
			$this->GetClassesPathFile()
			, serialize($this->arrClassesPath) 
		) ;
	}

	/**
	 * 扫描目录下的类
	 * 
	 * @access	private
	 * @param	$sDirectory			string		what's this
	 * @return	void
	 */
	private function _ScanClass($sDirectory,$sSubPath)
	{
		if($sDirectory===null)
		{
			$sDirectory = $this->GetPath() ;
		}
		
		// 整理 路径为统一格式
		$sDirectoryPath = realpath($sDirectory).'/' ;

		// 
		$hDir = opendir($sDirectoryPath) ;
		ASSERT::ASSERT_($hDir,Language::SentenceEx('无效的路径($sDirectory)：%s','JCAT',null,$sDirectory)) ;
		
		while( $sFilename=readdir($hDir) )
		{
			$sPath = $sDirectoryPath.$sFilename ;
			
			// 文件
			if(is_file($sPath))
			{
				foreach ($this->arrClassFilenameParser as $Parser)
				{
					$sClassName = call_user_func_array($Parser,array($sFilename)) ;
					if($sClassName)
					{
						$this->RegisterClass($sClassName,$sSubPath.$sFilename );						
						break ;
					}
				}
			}
			
			// 目录
			else if( is_dir($sPath) )
			{
				// 排除特殊目录
				if(in_array($sFilename,array('.','..','.svn')))
				{
					continue ;
				}
				
				// 递归子目录
				else
				{
					$this->_ScanClass($sPath,$sSubPath.$sFilename.'/') ;
				}
			}
			
			else
			{
				ASSERT::ASSERT_(0,"what's this: {$sPath} ?")  ;
			}
		}
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$sFilename
	 * @static 
	 * @return	string
	 */
	static public function ParseFilename($sFilename)
	{
		foreach (self::$arrClassFileRegexpPatterns as $sRegexp)
		{
			// 找到 类文件
			$arrRes = array() ;
			if( preg_match($sRegexp,$sFilename,$arrRes) )
			{
				if( isset($arrRes[1]) )
				{
					//return $arrRes[1] ;
					return str_replace('_','\\',$arrRes[1]) ;
				}
			}
		}
		
		return null ;
	}
	
	static private $arrClassFileRegexpPatterns = array(
			'/^class\.(.+)\.php$/i'
			, '/^interface\.(.+)\.php$/i'
	) ;
	
	/**
	 * Description
	 * 
	 * @access	private
	 * @var		array
	 */
	private $arrClassFilenameParser = array() ;
	
	/**
	 * Description
	 * 
	 * @access	private
	 * @var		array
	 */
	private $arrClassesPath = array() ;
	
	/**
	 * Description
	 * 
	 * @access	private
	 * @var		string
	 */
	private $sClassesPathFilename = 'inc.ClassesPath.php' ;
}

?>